/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.giraph.partition;

import org.apache.giraph.worker.WorkerContext;

/**
 * PartitionContext allows for the execution of user code
 * on a per-partition basis. There's one PartitionContext per partition.
 */
public interface PartitionContext {
  /**
   * Execute user code.
   * This method is executed once for each partition before computation for
   * that partition starts.
   *
   * @param workerContext Worker context
   */
  void preSuperstep(WorkerContext workerContext);

  /**
   * Execute user code.
   * This method is executed once on for each partition after computation in
   * current superstep for that partition ends.
   *
   * @param workerContext Worker context
   */
  void postSuperstep(WorkerContext workerContext);
}
